.. |hp-home| image:: Img/hp-icon.png .. |hp-del| image:: Img/hp-close.png .. |hp-lock| image:: Img/hp-lock.png .. |hp-move| image:: Img/hp-move.png .. |hp-edit| image:: Img/hp-edit.png .. |hp-align| image:: Img/hp-align.png .. |hp-switch| image:: Img/hp-switch.png .. |hp-keywords| image:: Img/hp-keywords.png .. |Add_ic2| image:: Img/Add_ic2.png .. hp-lock.png - иконка заблокированных настроек справа вверху hp-icon.png - иконка домашней страницы hp-move.png - передвинуть виджет hp-edit.png редактировать настройки hp-align.png -выравнять карточки hp-close.png закрыть hp-save-settings.png - сохранить отменить настройки hp-keywords.png .. _Руководство по настройке Домашней страницы: ############################################ Руководство по настройке Домашней страницы ############################################ ********************************************************** Назначение и общий функционал настройки домашней страницы ********************************************************** ================================= Назначение ================================= | **Домашняя страница** - это страница, настраиваемая администратором для отображения пользователям необходимой информации. | Как правило, является главной страницей, содержащей вводную и презентативную информацию о Системе, а также служит списком предлагаемых возможностей Системы и вариантом навигации по Системе. | Домашняя страница состоит из набора виджетов. Доступ к виджетам настраивается администратором системы. На Домашней странице могут отображаться следующие компоненты: * Карточки. * Инструментальная панель. * Карусель. * Баннер. * Лента новостей. * СмартИнпут. ================================= Общий функционал ================================= Домашняя страница также открывается из интернет-браузера по адресу: /home или нажатием на иконку "Домашняя страница" |hp-home| в навигационной цепочке, расположенной под верхним сайдбаром (:numref:`18Pic1`). .. _18Pic1: .. figure:: Img/Homepage1.png :scale: 80 % :align: center *Пример перехода к Домашней странице* После авторизации в Системе, после нажатия на иконку "Домашняя страница" |hp-home| либо после перехода по адресу, указанному выше, в рабочей области Системы откроется Домашняя страница. .. warning:: Иконка может быть настроена на другую страницу системы. Домашняя страница имеет два режима работы: *Режим просмотра* В этом режиме Домашняя страница отображается у Пользователя. В данном случае Пользователем является Администратор Системы. *Режим редактирования* По кнопке |hp-lock| Домашняя страница перейдет в режим редактирования (т.е. откроется Редактор домашней страницы). В этом режиме Администратор может добавлять, изменять и создавать компоненты Домашней страницы. Редактор Домашней страницы состоит из блока "Список компонентов", содержащего список возможных компонентов Домашней страницы, и рабочей области, содержащей шаблон Домашней страницы (:numref:`18Pic3`). .. _18Pic3: .. figure:: Img/Homepage3.png :scale: 80 % :align: center *Редактор Домашней страницы* Для перехода в режим просмотра Домашней страницы необходимо нажать на название блока "Список компонентов" (:numref:`18Pic3`). После этого блок "Список компонентов" скроется, на его месте появится кнопка |hp-lock|, а вместо шаблона Домашней страницы отобразится текущая Домашняя страница Пользователя. По умолчанию каждый блок размещается на всю ширину страницы. Ширину блока можно изменить, потянув за левую или правую границы блока. Таким образом, в одной строке можно разместить несколько блоков. Порядок размещения блоков соответствует очередности их добавления в шаблон. Порядок размещения блоков в шаблоне можно изменить перетаскиванием нужного блока на новое место. ================================= Перечень виджетов ================================= -------------------------------------------------- Виджет "Карточки" -------------------------------------------------- Виджет "Карточки" является аналогом бокового сайдбара. Группировка карточек в виджете "Карточки" соответствует группировке пунктов в боковом сайдбаре. Каждая карточка является ссылкой на соответствующую страницу Системы. Данный виджет удобен в использовании при работе в Системе с планшета или смартфона, так как каждая карточка является ссылкой на соответствующую страницу Системы. -------------------------------------------------- Виджет "Карусель" -------------------------------------------------- Виджет "Карусель" представляет собой контейнер с набором прокручивающихся по кругу картинок. Количество добавляемых в контейнер картинок неограничено. -------------------------------------------------- Виджет "Баннер" -------------------------------------------------- Виджет "Баннер" представляет собой контейнер с одной картинкой. ---------------------------------------------------------------------------------------------------- Виджет "Инструментальная панель" ---------------------------------------------------------------------------------------------------- В виджете "Инструментальная панель" можно вывести на Домашнюю страницу уже созданную в Системе инструментальную панель. ---------------------------------------------------------------------------------------------------- Виджет "Лента" ---------------------------------------------------------------------------------------------------- В виджете "Лента" настраивается отображение карточек с данными Системы и набор фильтров для отображения этих карточек. ---------------------------------------------------------------------------------------------------- Виджет "Смарт Инпут" ---------------------------------------------------------------------------------------------------- Виджет **SmartInput** – - компонент быстрого ввода данных. Позволяет в текстовом поле создавать описание и заполнять дополнительные атрибуты через специальные теги. Это достигается за счет использования тегов и преднастроенных шаблонов при создании записи, что позволяет избежать заполнения сложных форм. Шаблоны создает и настраивает Администратор Системы. Подробнее о настройке SmartInput см. :ref:`Руководство по настройке SmartInput`. ******************************** Основные операции ******************************** ================================= Добавление виджета ================================= Для добавления нового виджета необходимо перетащить его из блока "Список компонентов" в рабочую область Домашней страницы (:numref:`18Pic4`). .. _18Pic4: .. figure:: Img/Cards.png :scale: 80 % :align: center *Перетаскивание компонента "Карточки"* После этого в рабочей области откроется форма создания нового виджета в шаблоне Домашней страницы (:numref:`18Pic5`). .. _18Pic5: .. figure:: Img/Cards1.png :scale: 80 % :align: center *Форма создания нового компонента "Карточки"* ================================= Удаление виджета ================================= Удалить виджет можно по кнопке "Удалить" |hp-del| в правом верхнем углу виджета (:numref:`18Pic7`). ================================= Настройка виджета ================================= Настройка виджета выполняется по кнопке "Редактировать" |hp-edit| в левом верхнем углу виджета(:numref:`18Pic7`). После нажатия на эту кнопку откроется форма редактирования виджета. .. _18Pic7: .. figure:: Img/Cards2.png :scale: 80 % :align: center *Виджет Домашней страницы* ******************************** Настройка виджетов ******************************** ================================================================== Принципы организации формы настроек виджета ================================================================== Свойства виджетов распределены в окне настроек по закладкам (:numref:`18Pic7_1`): .. _18Pic7_1: .. figure:: Img/hp-tabs.png :scale: 80 % :align: center *Закладки настроек виджета* При настройке виджета необходимо установить значения свойств виджена, а затем сохранить или отменить изменения настроек (:numref:`18Pic7_2`): .. _18Pic7_2: .. figure:: Img/hp-save-settings.png :scale: 80 % :align: center *Сохранение или отмена изменений настроек виджета* .. _hp-common-attr: ================================= Общие настройки ================================= Общими для всех виджетов являются следующие настройки: *Имя элемента* Указывается имя элемента. *Роль* Указывается роль Пользователя, которая имеет доступ к виджету. .. note:: Имя элемента может быть локализованно. Для этого необходимо включить переключатель |hp-switch| около имени элемента и ввести имя элемента на разных языках. .. note:: Если для компонента не указано его локализованное наименование для текущей локали, то в качестве наименования компонента на Домашней странице будет использоваться значение из поля "Имя нового элемента". Если для компонента указано его локализованное наименование для текущей локали, то в качестве наименования компонента на Домашней странице будет использоваться это локализованное значение. ================================= Настройки виджета "Карточки" ================================= Данный виджет не имеет специальных настроек. ================================= Настройки виджета "Карусель" ================================= Виджет карусель содержит набор слайдов. По умолчанию на странице настроек представлены настройки для одного слайда: ----------------------------------- Настройки отдельного слайда ----------------------------------- *Название* Внутреннее название слайда *URL Картинки* | Ссылка на картинку. *Надпись картинки* | Содержит текст, отображаемый на слайде *Ссылка изображения* | Содержит ссылку, открываемую при нажатии на слайд. *Цвет заднего фона надписи* Содержит указание на цвет фона надбиси в формате **#541c1c**. Цвет можно выбрать с помощью "пипетки". .. note:: Ссылки могут содержать ключевые слова. Ключевые слова можно выбрать из меню по нажатию на кнопку |hp-keywords|. ----------------------------------- Добавление нового слайда. ----------------------------------- Добавить слайд можно по кнопке **Добавить** на форме настроек виджета под слайдами. ----------------------------------- Удаление слайда. ----------------------------------- Удалить слайд можно по кнопке |hp-del| в правом верхнем углу слайда. .. note:: Первый слайд удалить нельзя. ================================= Настройки виджета "Баннер" ================================= Этот виджет содержит следующие поля настроек: *Url картинки* Обязательное поле. Необходимо ввести Url картинки, которая будет отображаться в компоненте "Баннер". *Надпись картинки* Необязательное поле. Указывается надпись картинки. *Цвет надписи* Необязательное поле. Из палитры можно выбрать цвет надписи картинки. По умолчанию цвет надписи - белый. *Цвет заднего фона надписи* Необязательное поле. Из палитры можно выбрать цвет заднего фона надписи картинки. По умолчанию задний фон картинки прозрачный. *Описание* Необязательное поле. Указывается описание картинки, которое будет отображаться под надписью картинки. *Расположение надписи* Необязательное поле. Из выпадающего списка можно выбрать значение "Слева" или "Справа". По умолчанию (если расположение надписи не указано) надпись будет располагаться справа. *Ссылка изображения* Необязательное поле. Указывается ссылка на страницу, на которую произойдет переход после клика на картинку. .. note:: Ссылки могут содержать ключевые слова. Ключевые слова можно выбрать из меню по нажатию на кнопку |hp-keywords|. ================================================================== Настройки виджета "Инструментальная панель" ================================================================== Этот виджет содержит следующие поля настроек: *ID инструментальной панели* Обязательное поле. Следует указать идентификатор той инструментальной панели, которую необходимо отображать в компоненте "Инструментальная панель" Домашней страницы. ================================================================== Настройки виджета "Лента" ================================================================== ------------------------------------------------------------------ Вкладка "Свойства" ------------------------------------------------------------------ *Имя элемента* Общее свойство см (:numref:`hp-common-attr`) *Выбрать роль* Общее свойство см (:numref:`hp-common-attr`) *Вид представления* Выбор типа представления записей: * по умолчанию ( карточки) * Таймлайн (представление в виде списка "таймлайн") *Интервал обновления* Период обновления информации в виджете ( в минутах) *Кол-во карточек* Количество карточек отображаемых в виджете *ID формы* Идентификатор формы для отображения информации в виде карточек (выбирается из списка) *Схема фида* Указывается схема, используемая для выборки элементов виджета. .. note:: После заполнения вкладки свойств необходимо сохранить настройки и открыть их заново. Затем необходимо перейти к настройкам других закладок. ------------------------------------------------------------------ Вкладка "Фильтры" ------------------------------------------------------------------ **Фильтры** Данный раздел позволяет настроить фильтры, доступные пользователю, с помощью которых он моет настраивать информацию, отображаемую виджетом. Администратор может добавить несколько фильтров. Добавление фильтров осуществляется нажатием на кнопку **Добавить**. Для создания фильтра на одно поле схемы фида необходимо заполнить следующие поля (:numref:`18Pic18`): *Поле* Обязательное поле. Из выпадающего списка необходимо выбрать одно или несколько полей схемы фида, на которое нужно создать фильтр. *Тип* Обязательное поле. Из выпадающего списка необходимо выбрать один из двух типов ввода значения для фильтра: *select* Значение для фильтра Пользователь будет выбирать из выпадающего списка значений. *input* Значение для фильтра Пользователь будет вводить вручную. *Плейсхолдер* Необязательное поле. Можно ввести текст плейсхолдера для поля фильтра. *Лейбл* Необязательное поле. Можно ввести текст лейбла для поля фильтра. По кнопке "Показать настройки локализации" справа от текста лейбла можно указать локализованные значения для лейбла поля. Для создания фильтра на еще одно поле схемы фида необходимо нажать кнопку "Добавить" |Add_ic2| в блоке "Список фильтров фида" (:numref:`18Pic18`). .. _18Pic18: .. figure:: Img/Feed1.png :scale: 80 % :align: center *Форма создания нового компонента "Лента новостей"* После этого в блоке "Список фильтров фида" появятся пустые поля для создания фильтра на новое поле схемы фида (:numref:`18Pic19`). .. _18Pic19: .. figure:: Img/Feed2.png :scale: 80 % :align: center *Пустой блок "Список фильтров фида"* Удалить поля для создания фильтра на поле схемы фида можно по кнопке "Удалить" (:numref:`18Pic19`). По кнопке "Показать настройки локализации" (:numref:`18Pic18`) раскрывается форма с полями, в которых можно указать локализованные наименования данного компонента (:numref:`18Pic20`). Для сохранения значений локализации необходимо нажать на кнопку "Сохранить локализацию элемента" (:numref:`18Pic20`). Форма для указания локализованных наименований компонента сворачивается по кнопке "Скрыть настойки локализации" (:numref:`18Pic20`). .. _18Pic20: .. figure:: Img/Feed_loc.png :scale: 80 % :align: center *Пример локализации наименования компонента "Лента новостей"* .. note:: Если для компонента не указано его локализованное наименование для текущей локали, то в качестве наименования компонента на Домашней странице будет использоваться значение из поля "Имя нового элемента". Если для компонента указано его локализованное наименование для текущей локали, то в качестве наименования компонента на Домашней странице будет использоваться это локализованное значение. После заполнения всех необходимых полей следует нажать на кнопку "Отправить" (:numref:`18Pic18`). **Фильтры** | Данный раздел доступен после кнопки добавить. | В разделе можно настроить базовый фильтр, применяемый к ленте. | Можно добавить фильтры из существующего набора или создать новый фильтр аналогично тому, как создаются фильтры в консолях. .. note:: Сохраненное значение фильтра можно увидеть, выключив переключатель рядом с наименованием раздела. **Сортировка** В данном разделе можно настроить порядок сортировки записей в ленте. .. note:: Сохраненное значение сортировки можно увидеть, выключив переключатель рядом с наименованием раздела. ------------------------------------------------------------------ Вкладка "Редактировать вид представления" ------------------------------------------------------------------ Данная вкладка позволяет настроить отображение информации в представлении "Таймлайн". На данной вкладке настраивается представление по умолчанию и представления по условию. Для настройки представления необходимо настроить следующие свойства: *Слот заголовка* Определяет поля, которое будет отображаться в заголовке таймлайна. В настройках можно выбрать несколько полей, отображаемых в заголовке. *Слот подзаголовка* Определяет поле, которое будет отображаться в подзаголовке таймлайна. *Слот описания* Определяет поле, которое будет содержаться в поле описания таймлайна. *Слот даты* Определяет поле даты, которое будет отображаться в таймлайне *Иконка* Определяет иконку таймлайна *Палитра цветов* Определяет палитру настроек, используемую для enum полей в заголовке таймлайна. *Цвет фона* Определяет цвет фона иконки таймлайна *Ширина* Определяет область, занимаюмую текстом *Жирность шрифта* Определяет жирность шрифта *Тип отображения* Выбирается способ отображения информации. Выбирается из списка. Для настройки представления по условию необходимо настроить дополнительные поля: *ИД итема* Идентификатор поля, используемого для определения настроек представления *Оператор* Оператор сравнения *Значение* Значение используемое для сравнения при выборе представления ------------------------------------------------------------------ Вкладка "Результаты" ------------------------------------------------------------------ Данная вкладка позволяет настроить переход на форму при нажатии на элемент виджета ( настраивает переход на формы) **Дефолтные настройки перехода** Данный раздел позволяет настроить простые условия перехода: для всех элементов виджета будет открываться одна и та же форма. Для настройки необходимо настроить следующие поля: *Ид формы* Идентификатор формы, которая будет открываться *Ид поля* Идентификатор поля, который будет использоваться в качестве идентификатора формы. **Настройки параметров перехода** Данный раздел позволяет настроить сложные условия перехода: для разных элементов виджета будут открываться разные формы, в зависимости от значений элемента. Параметры настройки параметров перехода: *Название поля схемы маппинга (itemTypeFieldName)* Название поля, по значению которого определяется тип записи . *Значения поля схемы* Возможные значения в поле, используемом для определения открываемой формы. *ИД формы (form_id)* Соответствующий идентификатор формы, которая должна открываться в зависимости от значения в поле "obj_type_id". *ИД итема (item_id)* Название поля в схеме консоли, в котором лежит идентификатор записи, соответствующий идентификатору записи открываемой формы. ================================================================== Настройки виджета "Смарт Инпут" ================================================================== К виджету подключается несколько внешних скриптов: * MAIN. * OPERATORS. * TOOLBAR. * SUBMIT. * VALIDATION. Необходимо выбрать скрипты из реестра скриптов в соответсвующих полях.